home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / src / linux-headers-2.6.28-15 / include / acpi / acpiosxf.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-24  |  8.0 KB  |  287 lines
  1.  
  2. /******************************************************************************
  3.  *
  4.  * Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL).  These
  5.  *                    interfaces must be implemented by OSL to interface the
  6.  *                    ACPI components to the host operating system.
  7.  *
  8.  *****************************************************************************/
  9.  
  10. /*
  11.  * Copyright (C) 2000 - 2008, Intel Corp.
  12.  * All rights reserved.
  13.  *
  14.  * Redistribution and use in source and binary forms, with or without
  15.  * modification, are permitted provided that the following conditions
  16.  * are met:
  17.  * 1. Redistributions of source code must retain the above copyright
  18.  *    notice, this list of conditions, and the following disclaimer,
  19.  *    without modification.
  20.  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  21.  *    substantially similar to the "NO WARRANTY" disclaimer below
  22.  *    ("Disclaimer") and any redistribution must be conditioned upon
  23.  *    including a substantially similar Disclaimer requirement for further
  24.  *    binary redistribution.
  25.  * 3. Neither the names of the above-listed copyright holders nor the names
  26.  *    of any contributors may be used to endorse or promote products derived
  27.  *    from this software without specific prior written permission.
  28.  *
  29.  * Alternatively, this software may be distributed under the terms of the
  30.  * GNU General Public License ("GPL") version 2 as published by the Free
  31.  * Software Foundation.
  32.  *
  33.  * NO WARRANTY
  34.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  35.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  36.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  37.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  38.  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  39.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  40.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  41.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  42.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  43.  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  44.  * POSSIBILITY OF SUCH DAMAGES.
  45.  */
  46.  
  47. #ifndef __ACPIOSXF_H__
  48. #define __ACPIOSXF_H__
  49.  
  50. #include "platform/acenv.h"
  51. #include "actypes.h"
  52.  
  53. /* Types for acpi_os_execute */
  54.  
  55. typedef enum {
  56.     OSL_GLOBAL_LOCK_HANDLER,
  57.     OSL_NOTIFY_HANDLER,
  58.     OSL_GPE_HANDLER,
  59.     OSL_DEBUGGER_THREAD,
  60.     OSL_EC_POLL_HANDLER,
  61.     OSL_EC_BURST_HANDLER
  62. } acpi_execute_type;
  63.  
  64. #define ACPI_NO_UNIT_LIMIT          ((u32) -1)
  65. #define ACPI_MUTEX_SEM              1
  66.  
  67. /* Functions for acpi_os_signal */
  68.  
  69. #define ACPI_SIGNAL_FATAL           0
  70. #define ACPI_SIGNAL_BREAKPOINT      1
  71.  
  72. struct acpi_signal_fatal_info {
  73.     u32 type;
  74.     u32 code;
  75.     u32 argument;
  76. };
  77.  
  78. /*
  79.  * OSL Initialization and shutdown primitives
  80.  */
  81. acpi_status __initdata acpi_os_initialize(void);
  82.  
  83. acpi_status acpi_os_terminate(void);
  84.  
  85. /*
  86.  * ACPI Table interfaces
  87.  */
  88. acpi_physical_address acpi_os_get_root_pointer(void);
  89.  
  90. acpi_status
  91. acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
  92.                 acpi_string * new_val);
  93.  
  94. acpi_status
  95. acpi_os_table_override(struct acpi_table_header *existing_table,
  96.                struct acpi_table_header **new_table);
  97.  
  98. /*
  99.  * Spinlock primitives
  100.  */
  101. acpi_status acpi_os_create_lock(acpi_spinlock * out_handle);
  102.  
  103. void acpi_os_delete_lock(acpi_spinlock handle);
  104.  
  105. acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);
  106.  
  107. void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);
  108.  
  109. /*
  110.  * Semaphore primitives
  111.  */
  112. acpi_status
  113. acpi_os_create_semaphore(u32 max_units,
  114.              u32 initial_units, acpi_semaphore * out_handle);
  115.  
  116. acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
  117.  
  118. acpi_status
  119. acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
  120.  
  121. acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
  122.  
  123. /*
  124.  * Mutex primitives
  125.  */
  126. acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
  127.  
  128. void acpi_os_delete_mutex(acpi_mutex handle);
  129.  
  130. acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
  131.  
  132. void acpi_os_release_mutex(acpi_mutex handle);
  133.  
  134. /* Temporary macros for Mutex* interfaces, map to existing semaphore xfaces */
  135.  
  136. #define acpi_os_create_mutex(out_handle)    acpi_os_create_semaphore (1, 1, out_handle)
  137. #define acpi_os_delete_mutex(handle)        (void) acpi_os_delete_semaphore (handle)
  138. #define acpi_os_acquire_mutex(handle,time)  acpi_os_wait_semaphore (handle, 1, time)
  139. #define acpi_os_release_mutex(handle)       (void) acpi_os_signal_semaphore (handle, 1)
  140.  
  141. /*
  142.  * Memory allocation and mapping
  143.  */
  144. void *acpi_os_allocate(acpi_size size);
  145.  
  146. void __iomem *acpi_os_map_memory(acpi_physical_address where,
  147.                 acpi_size length);
  148.  
  149. void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
  150.  
  151. #ifdef ACPI_FUTURE_USAGE
  152. acpi_status
  153. acpi_os_get_physical_address(void *logical_address,
  154.                  acpi_physical_address * physical_address);
  155. #endif
  156.  
  157. /*
  158.  * Memory/Object Cache
  159.  */
  160. acpi_status
  161. acpi_os_create_cache(char *cache_name,
  162.              u16 object_size,
  163.              u16 max_depth, acpi_cache_t ** return_cache);
  164.  
  165. acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
  166.  
  167. acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
  168.  
  169. void *acpi_os_acquire_object(acpi_cache_t * cache);
  170.  
  171. acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
  172.  
  173. /*
  174.  * Interrupt handlers
  175.  */
  176. acpi_status
  177. acpi_os_install_interrupt_handler(u32 gsi,
  178.                   acpi_osd_handler service_routine,
  179.                   void *context);
  180.  
  181. acpi_status
  182. acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine);
  183.  
  184. void acpi_os_gpe_count(u32 gpe_number);
  185. void acpi_os_fixed_event_count(u32 fixed_event_number);
  186.  
  187. /*
  188.  * Threads and Scheduling
  189.  */
  190. acpi_thread_id acpi_os_get_thread_id(void);
  191.  
  192. acpi_status
  193. acpi_os_execute(acpi_execute_type type,
  194.         acpi_osd_exec_callback function, void *context);
  195.  
  196. acpi_status
  197. acpi_os_hotplug_execute(acpi_osd_exec_callback function, void *context);
  198.  
  199. void acpi_os_wait_events_complete(void *context);
  200.  
  201. void acpi_os_sleep(acpi_integer milliseconds);
  202.  
  203. void acpi_os_stall(u32 microseconds);
  204.  
  205. /*
  206.  * Platform and hardware-independent I/O interfaces
  207.  */
  208. acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);
  209.  
  210. acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
  211.  
  212. /*
  213.  * Platform and hardware-independent physical memory interfaces
  214.  */
  215. acpi_status
  216. acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width);
  217.  
  218. acpi_status
  219. acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width);
  220.  
  221. /*
  222.  * Platform and hardware-independent PCI configuration space access
  223.  * Note: Can't use "Register" as a parameter, changed to "Reg" --
  224.  * certain compilers complain.
  225.  */
  226. acpi_status
  227. acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
  228.                    u32 reg, u32 *value, u32 width);
  229.  
  230. acpi_status
  231. acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
  232.                 u32 reg, acpi_integer value, u32 width);
  233.  
  234. /*
  235.  * Interim function needed for PCI IRQ routing
  236.  */
  237. void
  238. acpi_os_derive_pci_id(acpi_handle rhandle,
  239.               acpi_handle chandle, struct acpi_pci_id **pci_id);
  240.  
  241. /*
  242.  * Miscellaneous
  243.  */
  244. acpi_status acpi_os_validate_interface(char *interface);
  245. acpi_status acpi_osi_invalidate(char* interface);
  246.  
  247. acpi_status
  248. acpi_os_validate_address(u8 space_id, acpi_physical_address address,
  249.              acpi_size length, char *name);
  250.  
  251. u64 acpi_os_get_timer(void);
  252.  
  253. acpi_status acpi_os_signal(u32 function, void *info);
  254.  
  255. /*
  256.  * Debug print routines
  257.  */
  258. void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
  259.  
  260. void acpi_os_vprintf(const char *format, va_list args);
  261.  
  262. void acpi_os_redirect_output(void *destination);
  263.  
  264. #ifdef ACPI_FUTURE_USAGE
  265. /*
  266.  * Debug input
  267.  */
  268. u32 acpi_os_get_line(char *buffer);
  269. #endif
  270.  
  271. /*
  272.  * Directory manipulation
  273.  */
  274. void *acpi_os_open_directory(char *pathname,
  275.                  char *wildcard_spec, char requested_file_type);
  276.  
  277. /* requeste_file_type values */
  278.  
  279. #define REQUEST_FILE_ONLY                   0
  280. #define REQUEST_DIR_ONLY                    1
  281.  
  282. char *acpi_os_get_next_filename(void *dir_handle);
  283.  
  284. void acpi_os_close_directory(void *dir_handle);
  285.  
  286. #endif                /* __ACPIOSXF_H__ */
  287.